Skip to main content

Маршрутизация (Routes)

Определение и принципы​

Прочтите Определения и принципы Маршрутизация (Routes)

Правила​

  • Файлы маршрутов API должны быть названы в соответствии с версией, доступностью и функциональностью их API. например CreateOrder.v1.public.php, FulfillOrder.v2.public.php, CancelOrder.v1.private.php и тд.
  • Файлы веб-маршрута очень похожи на веб-файлы API, но они могут называться как угодно.

Структура папок​

 - usr
    - modules
        - {module-name}
            - UI
                - API
                   - Routes
                      - CreateItem.v1.public.php
                      - DeleteItem.v1.public.php
                      - CreateItem.v2.public.php
                      - DeleteItem.v1.private.php
                      - ActiveItem.v1.private.php
                      - ...
                - WEB
                   - Routes
                      - main.php
                      - ...

Примеры кода​

Web и API маршруты​

Маршруты определяются точно так же, как вы определили бы их в Laravel.

Route::post('hello', [Controller::class, 'sayHello']);

Защищенный маршрут (API)​

Route::get('users', [Controller::class, 'listAllUsers'])
    ->middleware(['auth:api']);

Разница между публичными и приватными маршрутами​

У Darklyy есть 2 типа конечных точек:

  • Общедоступная [public] - в основном для сторонних клиентов
  • Частная [private] - для ваших собственных приложений

Это поможет создать отдельную документацию для каждого и сохранить конфиденциальность вашего внутреннего API.